Signal Confirm Online PSTN Gateway

The Signal Confirm Online PSTN Gateway request creates a new Online PSTN Gateway with Correlation Id.

HTTP Method

POST

URI

Copy
{{baseUrl}}/api/v3/customer/CustomerGuid/addNewOnlinePstnGateway/{correlationId}

Request Parameters

Parameter

Type

Description

CustomerGuid

string ($uuid)

umpCustomerGuid created in the Live Platform customer tenant SQL database :

Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

correlationId string  

Example Response

Copy

            

HTTP Responses

200 OK

Attribute

Type

Description

     
     
404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter

Type

Description

type

string

Error type

title

string

Email title

status

integer

StatusCodes.Status400BadRequest

detail

string

Additional error details.

instance

string

HttpContext.Request.Path

errorTicket

string

errId.ToString()

errorCode

string

Error code output in the request

traceId

string

HttpContext.TraceIdentifier

additionalProp1

string

TBD

additionalProp2

string

TBD

additionalProp3

string

TBD